IGroup.Stop method

Commands a controlled motion stop and transfers the axis group to the state GroupStopping. It aborts any ongoing method execution. While the axis group is in the GroupStopping state, no other function can perform any motion on this axis group. After the axis group has reached velocity zero, the Done field of IKsCommand is set to true immediately. To leave the GroupStopping state and go to GroupStandstill, use IKsCommand.Abort.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

IStopCommand Stop(
       double deceleration,
       double jerk
)

Function Stop(
       deceleration As Double,
       jerk As Double
) As IStopCommand

Parameters

deceleration

Type: double

The value of the deceleration. The unit is determined by McProfileType. [unit/second²] or [second]

jerk

Type: double

The value of the jerk. The unit is determined by McProfileType. [unit/second³] or [second]

Return value

Type: IStopCommand

Returns a state of a stop.